OSPF Configuration Mode Commands

OSPF Configuration Mode Commands
 
 
The OSPF Configuration sub-mode is used to configure the OSPF routing protocol. This mode includes commands that configure OSPF routing parameters.
 
note_smallImportant: The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).
 
area authentication
Enables authentication for the specified OSPF area.
Product
PDSN, HA GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } authentication [ message-digest ]
no area { ipaddress | decimal_value } authentication [ message-digest ]
no
Disables authentication for the specified area.
ipaddress
IP address in IPv4 dotted-decimal notation of the area where authentication will be enabled.
decimal-value
The identification number of the area where authentication will be enabled. This must be an integer from 0 through 4294967295.
message-digest
Sets the OSPF authentication type to use the message digest 5 (MD5) authentication method.
Usage
Use this command to enable authentication of OPSF areas.
Example
The following command enables authentication for an OSPF area defined by the IP address 192.168.100.10 and the OSPF authentication type to MD5:
area 192.168.100.10 authentication message-digest
 
area default-cost
This command configures the default cost for an area.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } default-cost cost_value
no area { ipaddress | decimal_value } default-cost cost_value
no
Deletes the default cost for the area.
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the area.
decimal-value
The identification number of the area. This must be an integer from 0 through 4294967295.
cost_value
The default cost to be configured for the specified area. This must be an integer from 0 through 16777215.
Usage
Use this command to configure the default cost for an OSPF area.
Example
The following command sets the default cost for an OSPF area defined by the IP address 192.168.100.10 to 300:
area 192.168.100.10 default-cost 300
 
area nssa
Define an area as an NSSA (Not So Stubby Area) and configure OSPF parameters for it.
Product
PDSN, HA GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } nssa [ default-information-originate | no-redistribution | no-summary | translate-always | translate-candidate | translate-never ][ no-redistribution ] [ no-summary ] [ translate-always ] [ translate-candidate ] [ translate-never ]
no area { ipaddress | decimal_value } nssa [ default-information-originate | no-redistribution | no-summary | translate-always | translate-candidate | translate-never ][ no-redistribution ] [ no-summary ] [ translate-always ] [ translate-candidate ] [ translate-never ]
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the NSSA area.
decimal-value
The identification number of the NSSA area. This must be an integer from 0 through 4294967295.
default-information-originate
Originate default information to the NSSA area
no-redistribution
Do not redistribute external routes to the NSSA area
no-summary
Do not inject inter-area routes into NSSA
translate-always
Configure NSSA-ABR to always translate
translate-candidate
Configure NSSA-ABR for translate election ( This is enabled by default. )
translate-never
Configure NSSA-ABR to never translate
Usage
Use this command to define NSSA areas.
Example
The following command defines the area designated by the IP address 192.168.100.10 as an NSSA area:
area 192.168.100.10 nssa
 
area stub
This command defines an area as a stub area.
Product
PDSN, HAGGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } stub [ no-summary ]
no area { ipaddress | decimal_value } stub [ no-summary ]
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the stub area.
decimal-value
The identification number of the stub area. This must be an integer from 0 through 4294967295.
no-summary
Disables (stops) the ABR from sending summary LSAs into the stub area.
Usage
Use this command to define an OPSF area as a stub area.
Example
The following command defines the OSPF area defined by the IP address 192.168.100.10 as a stub area:
area 192.168.100.10 stub
 
area virtual-link
This command configures a virtual link between an area that cannot be physically connected to the network backbone and an area that is physically connected to the network backbone.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } virtual-link router_id_address
no area { ipaddress | decimal_value } virtual-link router_id_address
no
Disables area virtual-link.
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the transit area.
decimal-value
The identification number of the transit area. This must be an integer from 0 through 4294967295.
router_id_address
The router id, in dotted-decimal notation, of the ABR to be linked to.
Usage
Use this command to create a virtual link between an area that is connected to the network backbone and an area that cannot be connected to the network backbone.
Example
The following command creates a virtual link between the OSPF areas defined by the IP address 192.168.100.10 and the IP address 192.168.200.20:
area 192.168.100.10 virtual-link 192.168.200.20
 
area virtual link authentication
This command configures the OSPF authentication method to be used by the virtual link between an area that cannot be physically connected to the network backbone and an area that is physically connected to the network backbone.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } virtual-link router_id_address authentication { message-digest | null | text }
no area { ipaddress | decimal_value } virtual-link router_id_address authentication { message-digest | null | text }
no
Disables area virtual link authentication.
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the transit area.
decimal-value
The identification number of the transit area. This must be an integer from 0 through 4294967295.
router_id_address
The router id, in dotted-decimal notation, of the ABR to be linked to.
message-digest
Set the OSPF authentication type to use the message digest (MD) authentication method.
null
Set the OSPF authentication type to use no authentication, thus disabling either MD or clear text methods.
text
Set the OSPF authentication type to use the clear text authentication method.
Usage
Use this command to set the authentication method for a virtual link between an area that is connected to the network backbone and an area that cannot be connected to the network backbone.
Example
The following command sets the authentication method for a virtual link between the OSPF areas defined by the IP address 192.168.100.10 and the IP address 192.168.200.20 to use no authentication:
area 192.168.100.10 virtual-link 192.168.200.2 null
 
area virtual-link authentication-key
This command configures the authentication password for the virtual link between an area that cannot be physically connected to the network backbone and an area that is physically connected to the network backbone.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } virtual-link router_id_address authentication-key [ encrypted password encrypted_authentication_key] password authentication_key
no area { ipaddress | decimal_value } virtual-link router_id_address authentication-key [ encrypted password encrypted_authentication_key] password authentication_key
no
Disables area virtual link authentication key.
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the transit area.
decimal-value
The identification number of the transit area. This must be an integer from 0 through 4294967295.
router_id_address
The router id, in dotted-decimal notation, of the ABR to be linked to.
encrypted password
encrypted_authentication_key is a string variable of size 1 to 523.
Use this if you are pasting a previously encrypted authentication key into the CLI command.
password authentication_key
The password to use for authentication. authentication_key is a string variable, from 1 through 16 alphanumeric characters, that denotes the authentication password. This variable is entered in clear text format.
Usage
Use this command to specify the authentication password for a virtual link between an area that is connected to the network backbone and an area that cannot be connected to the network backbone.
Example
The following command creates an authentication password of 123456 for a virtual link between the OSPF areas defined by the IP address 192.168.100.10 and the IP address 192.168.200.20:
area 192.168.100.10 virtual-link 192.168.200.20 authentication-key password 123456
 
area virtual link intervals
This command configures the interval or delay type, and the delay time in seconds, for the virtual link between an area that cannot be physically connected to the network backbone and an area that is physically connected to the network backbone.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } virtual-link router_id_address [ dead-interval value ] [ hello-interval value ] [ retransmit-intervalvalue ] [ transmit-delay value ] [ dead-interval value ] [ hello-interval value ] [ retransmit-interval value ] [ transmit-delay value ]
no area { ipaddress | decimal_value } virtual-link router_id_address [ dead-interval value ] [ hello-interval value ] [ retransmit-intervalvalue ] [ transmit-delay value ] [ dead-interval value ] [ hello-interval value ] [ retransmit-interval value ] [ transmit-delay value ]
no
Disables area virtual link intervals.
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the area.
decimal-value
The identification number of the transit area. This must be an integer from 0 through 4294967295.
router_id_address
The router id, in dotted-decimal notation, of the ABR to be linked to.
dead-interval value
The interval, in seconds, that the router should wait, during which time no packets are received and after the router considers a neighboring router to be off-line. value must be an integer from 1 through 65535.
hello-interval value
The interval, in seconds before sending a hello packet. value must be an integer from 1 through 65535.
retransmit-interval value
The interval, in seconds, that router should wait before retransmitting a packet. value must be an integer from 1 through 3600.
transmit-delay value
The interval, in seconds, that the router should wait before transmitting a packet. value must be an integer from 1 through 3600.
Usage
Use this command to set the intervals or delay types for a virtual link between an area that is connected to the network backbone and an area that cannot be connected to the network backbone.
Example
The following command sets the retransmit interval for a virtual link between the OSPF areas defined by the IP address 192.168.100.10 and the IP address 192.168.200.20 to 60 seconds:
area 192.168.100.10 virtual-link 192.168.200.20 retransmit-interval 60
 
area virtual link message-digest-key
This command enables the use of MD5-based OSPF authentication for the virtual link between an area that cannot be physically connected to the network backbone and an area that is physically connected to the network backbone.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
area { ipaddress | decimal_value } virtual-link router_id_address message-digest-key key_id md5 [ encrypted password encrypted_authentication_key] password authentication_key
no area { ipaddress | decimal_value } virtual-link router_id_address message-digest-key key_id md5 [ encrypted password encrypted_authentication_key] password authentication_key
no
Disables area virtual link message digest key.
ipaddress
The IP address, in IPv4 dotted-decimal notation, of the transit area.
decimal-value
The identification number of the transit area. This must be an integer from 0 through 4294967295.
router_id_address
The router id, in dotted-decimal notation, of the ABR to be linked to.
message-digest-key key_id
Specifies the key identifier number. key_id must be an integer from 1 through 255.
encrypted password
encrypted_authentication_key is a string variable of size 1 to 523.
Used this if you are pasting a previously encrypted authentication key into the CLI command.
password authentication_key
The password to use for authentication. authentication_key is a string variable, from 1 through 16 alphanumeric characters, that denotes the authentication password. This variable is entered in clear text format.
Usage
Use this command to enable the use of MD5-based OSPF authentication for a virtual link between an area that is connected to the network backbone and an area that cannot be connected to the network backbone.
Example
The following command enables the use of MD5-based OSPF authentication for a virtual link between the OSPF areas defined by the IP address 192.168.100.10 and the IP address 192.168.200.20, sets the MD5 Key ID to 25, and the password to 123456:
area 192.168.100.10 virtual-link 192.168.200.20 message-digest-key 25 md5 password 123456
 
capability graceful-restart
This command configures graceful-restart. By default, capability is set to enabled.
Product
PDFN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
capability graceful-restart
no capability graceful-restart
no
Disables capability graceful-restart.
Usage
Use this command to configure graceful-restart.
Example
The following command configure capability graceful-restart:
capability graceful-restart
 
default-information originate
This command creates a default external route into an OSPF routing domain.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
default-information originate [ always ] [ metric metric_value ] [ metric-type { 1 | 2 } ] [ route-map route_map_name ]
always
Indicates that the route should always be advertised, regardless of whether the software has a default route or not.
metric metric_value
Sets the OSPF metric used in creating the default route. This must be an integer from 1 through 16777214.
metric-type { 1 | 2 }
Sets the default route metric type.
1 : Sets the OSPF external link type for default routes to Type 1.
2 : Sets the OSPF external link type for default routes to Type 2.
route-map route_map_name
Specifies the name of the default route-map to be use. This must be specified as a string of 1 through 79 alphanumeric characters.
Usage
Use this command to set the default external route into an OSPF routing domain.
Example
The following command sets the default external route to originate from the routemap named rmap1:
default-information originate route-map rmap1
 
default metric
This command configures the default metric value for the OSPF routing protocol.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
default-metric metric_value
no default-metric
metric-value
The metric value to set. This must be an integer from 1 through 16777214. The default metric value setting is 26385.
no
Enables/Disables the followed option
Usage
Use this command to set the default metric for routes.
Example
The following command sets the default metric to 235:
default-metric 235
 
distance
This command configures the OSPF route administrative distances for all OSPF route types or based on specific route type.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
distance { distance_value | ospf { [ external distance_value ] [ inter-area distance_value ] [ intra-area distance_value ] } }
no distance { distance_value | ospf { [ external distance_value ] [ inter-area distance_value ] [ intra-area distance_value ] } }
distance_value
is an integer, ranging from 1 to 255, that sets OSPF route administrative distances. The default distance value is 110.
ospf { [ external distance_value ] [ inter-area distance_value ] [ intra-area distance_value ] }
Set the distance value for the specified route type.
external distance_value: Set the OSPF route administrative distance for routes from other routing domains, learned by redistribution. This must be an integer from 1 through 255. The default is 110.
inter-area distance_value: sets the OSPF route administrative distance for routes from one routing area to another. This must be an integer from 1 through 255. The default is 110.
intra-area distance_value: sets the OSPF route administrative distance for all routes within an area. This must be an integer from 1 through 255. The default is 110.
no
Enables/Disables the followed option.
Usage
Use this command to set the administrative distance for OSPF routes.
Example
The following command sets the administrative distance for all OSPF route types to 30:
distance 30
 
distribute-list
This command enables the filtering of networks in outgoing routing updates.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
distribute-list route_access_list out { connected | rip | static }
nodistribute-list route_access_list out { connected | rip | static }
route_access_list
The name of the OSPF route access list to use. This is an alphanumeric string up to 63 characters in length.
connected
Filter connected routes.
rip
Filter RIP routes. (RIP is not supported at this time.)
static
Filter static routes.
no
Enables/Disables the followed option.
Usage
Use this command to enable the filtering of outgoing route updates by using the specified route access list.
Example
The following command uses the route access list named ral1 to filter outgoing routing updates for all connected routes:
distribute-list ral1 out connected
 
end
Exits the NTP configuration mode and returns to the Exec mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
end
Usage
Change the mode back to the Exec mode.
 
exit
Exits the NTP configuration mode and returns to the global configuration mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
exit
Usage
Return to the global configuration mode.
 
ip vrf
This command configures the VRF instances for OSPF routing protocol.
Product
All
Privilege
Security Administrator, Administrator
Syntax
ip vrf vrf_name
no ip vrf vrf_name
no
Disables the VRF instances and removes the configured VRF context association for OSPF routing.
vrf_name
vrf_name is name of a preconfigured virtual routing and forwarding (VRF) context configured in Context Configuration Mode through ip vrf command.
Usage
Use this command to configure the IP VRF forwarding also to associate the preconfigured VRF context with the specific tunnel interface.
This command creates and enters the OSPF VRF Configuration Mode if required to configure the VRF context instances for OSPF routing.
Example
The following command enables preconfigured VRF context instance ospf_vrf1 for OSPF routing and enters the OSPF VRF Configuration mode:
ip vrf ospf_vrf1
 
neighbor
This command configures OSPF routers that interconnect to non-broadcast networks.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
neighbor ip_address [ poll-interval poll_interval_value ] [ priority priority_value ]
ip_address
The interface IP address of the OSPF neighbor. This must be an IP address entered in dotted-decimal notation.
poll-interval poll_interval_value
Default: 120
Set the number of seconds in the dead neighbor polling interval. This must be an integer from 1 through 65535
priority priority_value
Default: 0
Set the 8-bit number that represents the router priority value of the non-broadcast neighbor associated with the IP address specified. This must be an integer from 0 through 255. This keyword does not apply to point-to-multipoint interfaces.
Usage
Use this command to configure OSPF routers that connect to non-broadcast networks.
Example
The following command specifies an OSPF router neighbor with the IP address of 192.168.100.10:
neighbor 192.168.100.10
 
network area
This command enables OSPF on an interface and defines the OSPF area for that network.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
network network_ip_address / network_mask area { area_id | area_ip_address }
network_ip_address/network_mask
The network address and mask that specify the interface on which OSPF will be enabled. This in entered in dotted-decimal notation, followed by the “/” and the mask. Example: 192.168.1.0/24.
area_id
The OSPF area identification number for the specified network. This must be an integer from 0 through 4294967295.
area_ip_address
The IP address of the OSPF area for the specified network. This must be entered in dotted-decimal notation.
Usage
Use this command to specify the IP address of the network interface that the OSPF router will use.
Example
The following command specified that the OSPF router will use the interface at IP address 192.168.1.0 with a netmask of 24:
network 192.168.1.0/24
 
ospf graceful-restart
This command helps configure graceful-restart specific settings.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
ospf graceful-restart { grace-period grace_period | helper { never | policy { only-reload | only-upgrade } }
grace-period grace-period
OSPF graceful restart grace period (seconds) is the time in which OSPF restarts, it should be and integer between 1 to 1800. Default grace period is 60 seconds.
helper { never | policy }
Helps configure OSPF helper settings.
never: Specifies never as helper.
policy { only-reload | only-upgrade }: Allows ospf graceful-restart helper policy.
•
only-reload: Allows ospf graceful-restart helper policy only-reload.
•
only-upgradeAllows ospf graceful-restart helper policy only-upgrade.
Default is ospf graceful-restart grace-period.
Usage
Use this command to configure graceful-restart specific settings.
Example
The following command sets the graceful restart grace period to 60 seconds:
ospf graceful-restart grace-period 60
ospf graceful-restart helper policy only-reload
ospf graceful-restart helper policy only-upgrade
 
ospf router-id
This command configures the router ID for the OSPF process.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
ospf router-id ip_address
no ospf router-id ip_address
ip_address
The router ID for the OSPF process. This must be an IP address entered in dotted-decimal notation
no
Disables the router ID for the OSPF process.
Usage
Use this command to set the router ID for the current OSPF router process.
Example
The following command sets the router ID to 192.168.200.1:
ospf router-id 192.168.200.1
 
passive-interface
This command enables the suppression of OSPF routing updates on the specific interface.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
passive-interface interface_name
no passive-interface interface_name
interface_name
The name assigned to a logical interface within the specific context. An interface name can be from 1 through 79 alphanumeric characters.
no
Disables the name assigned to a logical interface within the specific context.
Usage
Use this command to suppress router updates on an interface in the current context.
Example
The following command suppresses OSPF routing updates on the interface named Intfc1:
passive-interface Intfc1
 
redistribute
This command redistributes routes into OSPF. This means that any routes from another protocol are redistributed to OSPF neighbors using the OSPF protocol.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
redistribute { bgp | connected | rip | static } [ metric metric_value ] [ metric-type { 1 | 2 } ] [ route-map route_map_name ]
no redistribute { bgp | connected | rip | static }
bgp
Specifies that BGP routes will be redistributed.
note_smallImportant: BGP routing is only supported for use with the HA.
no
Disables the redistributed.
connected
Specifies that connected routes will be redistributed.
rip
Specifies that RIP routes will be redistributed. (RIP is not supported at this time.)
static
Specifies that static routes will be redistributed.
metric metric_value
Sets the OSPF metric used in the redistributed route. This must be an integer from 1 through 16777214.
metric-type { 1 | 2 }
Default: 2
Sets route metric type that is applied to redistributed routes.
1 : Sets the OSPF external link type for routes to Type 1.
2 : Sets the OSPF external link type for routes to Type 2.
route-map route_map_name
Filter routes through the specified route map before redistribution. route_map_name specifies the name of the route-map to use and must be specified as a string of 1 through 79 alphanumeric characters.
Usage
Use this command to define what routing protocols should have their routes redistributed into OSPF.
Example
The following command defines that BGP routes should be redistributed:
redistribute bgp
 
refresh timer
This command adjusts the OSPF refresh timer.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
refresh timer value
no refresh timer value
no
Disables refresh timer.
value
Default: 10
The minimum amount of time, in seconds, to wait before refreshing an LSA. This must be an integer from 10 through 1800.
Usage
Use this command to define the amount of time to wait before refreshing an LSA.
Example
The following command sets the refresh timer to 90 seconds:
refresh timer 90
 
router-id
This command configures the router ID for the OSPF process.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
router-id ip_address
no router-id ip_address
no
Disables router ID for the OSPF process.
ip_address
The router ID for the OSPF process. This must be an IP address entered in dotted-decimal notation.
Usage
Use this command to set the router ID for the current OSPF router process.
Example
The following command sets the router ID to 192.168.200.1:
router-id 192.168.200.1
 
timers spf
This command adjusts the SPF timers.
Product
PDSN, HA, GGSN
Privilege
Security Administrator, Administrator
Syntax
timers spf delay_value  hold_time_value
no timers spf
no
Disables SPF timers.
delay_value
Default: 5
The delay time, in seconds, between receiving changes to an SPF calculation. This must be an integer from 0 through 4294967295.
hold_time_value
Default: 10
The hold time, in seconds, between consecutive SPF calculations. This must be an integer from 0 through 4294967295.
Usage
Use this command to set the SPF delay and hold timers for the current OSPF router process.
Example
The following command sets the delay timer to 15 and the hold timer to 15:
timers spf 15 15
 
 
Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883